home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / docs / PhpDocumentor / Release-1.2.3 < prev   
Text File  |  2004-03-24  |  19KB  |  410 lines
  1. $Id: Release-1.2.3,v 1.1.2.6 2003/10/13 03:09:36 CelloG Exp $
  2.  
  3. PhpDocumentor Version 1.2.3
  4. ################################################################################
  5. http://www.phpdoc.org
  6. Joshua Eichorn jeichorn@phpdoc.org
  7. Gregory Beaver cellog@users.sourceforge.net
  8. ################################################################################
  9. ################################################################################
  10.  
  11. The phpDocumentor team would like to announce the release of phpDocumentor
  12. 1.2.3.  This is a bugfix maintenance release.  Only a few small bugs have been
  13. found and fixed.
  14.  
  15. WARNING: in order to use the web interface through PEAR, you must set your
  16. data_dir to a subdirectory of your document root.
  17.  
  18. $ pear config-set data_dir /path/to/public_html/pear
  19.  
  20. on Windows with default apache setup, it might be
  21.  
  22. C:\> pear config-set data_dir "C:\Program Files\Apache\htdocs\pear"
  23.  
  24. After this, install/upgrade phpDocumentor
  25.  
  26. $ pear upgrade phpDocumentor
  27.  
  28. and you can browse to:
  29.  
  30. http://localhost/pear/PhpDocumentor/
  31.  
  32. for the web interface
  33.  
  34. for PEAR programmers, the new --pear command-line switch will be a boon.  Leave
  35. it on by default if your package follows PEAR coding and directory naming standards
  36.  
  37. ------
  38. IMPORTANT: phpDocumentor 1.2.3 requires PHP version 4.1.0 or greater.
  39. phpDocumentor will function best with PHP version 4.3.0 or greater, as it will
  40. use of the tokenizer extension if php 4.3.0 is installed for a tremendous
  41. increase in parsing speed.
  42. ------
  43.  
  44. Speaking of speed, do NOT run the PDF Converter with --sourcecode = on for any
  45. medium to large sized projects.  I had to kill a PDF generation after 36 hours
  46. on a Pentium IV 2.66GHz computer - 36 hours!  The design of the PDF generation
  47. library is tremendously inefficient, probably on the order of O(n^2).  I'd fix
  48. this if I knew anything about PDF.  If there are any users out there with the
  49. time and expertise to look into the algorithms used by CPdf, we would all
  50. appreciate it.
  51.  
  52. phpDocumentor is a JavaDoc-like automatic documentation generator for PHP
  53. written in PHP.  It is the most versatile tool for documenting PHP.
  54.  
  55. Once again, phpDocumentor brings a great increase in usability with the 1.2
  56. branch.  The addition of a tokenizer-based parser increases parsing speed by
  57. up to 4 times (that's 400% faster) compared to previous versions.  In addition,
  58. scalability has been improved, allowing generation of documents in multiple
  59. output formats with one command.  The usage of config files makes repetitive
  60. parsing tasks straightforward and reduces the chance for error.
  61.  
  62. The addition of DocBlock templates, extended documentation (tutorials) parsing,
  63. and many other new features make this release the most useful automatic
  64. documentor for any programming language.
  65.  
  66. The default HTML Converter has been ported to a new Smarty-based converter,
  67. HTMLframesConverter, and all of the old templates have been ported to the new
  68. Smarty-based format.  The HTMLdefaultConverter has been deprecated since its
  69. functionality is redundant.  Due to the time it takes to convert a template to
  70. the new format, the phpDocumentor team extends an offer to do this conversion
  71. for anyone who has a brand new template.  We may also include the template in a
  72. future release, if permission is granted.
  73.  
  74. Due to interest from PEAR programmers, there is a new beta-quality XML:DocBook
  75. converter with peardoc2 templates.  This converter could also generate other
  76. DocBook formats, if desired, but does not generate indexing for this release.
  77.  
  78. The PDF Converter has stepped up to beta-quality, is fully templatable, and
  79. has most bugs completely fixed.  The CHM converter has also taken major strides
  80. and is beta quality.
  81.  
  82. As predicted, the Smarty template engine is the primary template engine for
  83. all converters.
  84.  
  85. For users new to phpDocumentor, phpDocumentor uses an event-driven parser
  86. and intermediary data structures that allow it to perform at a level other
  87. automatic documentors for PHP cannot achieve:
  88.   --parsing any php file, with multiple classes and functions in the same file
  89.   --fully compliant with even the most esoteric php syntax 
  90.       ($string = <<< EOF, for example)
  91.   --ability to generate multiple output formats
  92.   --extremely fast parsing
  93.   --error/warnings by line number and file to allow for debugging of
  94.     documentation tags
  95.   --multiple output templates to easily customize the look of generated
  96.     documentation
  97.   --extensive documentation of the package, including a detailed specification
  98.     for tags and the included template engine
  99.   --open source, GPL
  100.   
  101.  
  102. A full listing of all closed bugs and feature requests can be found in the 
  103. next section of the notes
  104.  
  105. phpDocumentor 1.2.3 ready for production use documenting any PHP project,
  106. download it and try the most advanced solution for PHP documentation
  107. today.
  108.  
  109. ################################################################################
  110.  
  111. The following bugs are fixed in version 1.2.3
  112.  [ 731750 ] Links to unparsed includes shown (2nd time reopened)
  113.  [ 771531 ] body styles not explicitly white
  114.  [ 795095 ] top_frame.tpl doesn't output single RIC element
  115.  [ 797066 ] HighlightParser stuffs whitespace in start of string in func
  116.  [ 802891 ] Inline link text does not show up
  117.  
  118. The following bugs are fixed in version 1.2.2
  119.  [ 765455 ] phpdoc can't find php if it is in /usr/local/bin
  120.  [ 767251 ] broken links when no files in default package
  121.  [ 768947 ] Multiple vars not recognised
  122.  [ 772441 ] nested arrays fail parser
  123.  [ 778920 ] tutorial link warning
  124.  [ 779552 ] "Documention" instead of "Documentation" in generated pages
  125.  [ 780332 ] {@link} is closing the link prematurely when a ',' is found
  126.  [ 781913 ] usedby not when @uses at class level
  127.  [ 784810 ] stat failing.
  128.  [ 786180 ] simple lists fail if line starts with an inline tag
  129.  [ 788251 ] {@link function blah()} and {@link object blah} fail
  130.  [ 788271 ] HighlightParser links to methods before classes
  131.  [ 790685 ] HighlightParser doesn't link class::method() outside methods
  132.  [ 791023 ] bug in output: <br; />
  133.  [ 791030 ] old PHP version bug /t and ' becomes to "
  134.  [ 791131 ] old PHP version bug in output, if define contains "("
  135.  [ 791291 ] ignoretags handling incorrectly looks for ignore-tags
  136.  
  137. The following bugs are fixed in version 1.2.1
  138.  [ 731750 ] Links to unparsed includes shown (reopened)
  139.  [ 735134 ] HTML:Smarty:default Documentation can not be printed
  140.  [ 749446 ] php-cli.exe has been renamed in the PHP 4.3.x distribution
  141.  [ 749841 ] The links do not work in errors.html. Page has no achors.
  142.  [ 750264 ] @ignore won't work with DocBlock Templates /**#@+
  143.  [ 750392 ] Formatting doesn't work in Templates /**#@+
  144.  [ 751066 ] Return type of a constructor is not void.
  145.  [ 751101 ] output error when optional parameters are in use
  146.  [ 752015 ] Docbuilder problems
  147.  [ 752040 ] phpDocumentor 1.2.0 can't parse itself in php < 4.3.0
  148.  [ 753278 ] @see parent::_privatefunc causes endless loop
  149.  [ 753641 ] phpdoc -h output
  150.  [ 755681 ] include error in docbuilder file_dialog.php
  151.  [ 755688 ] lost image(s)
  152.  [ 756730 ] preview image for HTML:Smarty not found
  153.  [ 757841 ] JavaScript-Error cause of Package-Name
  154.  [ 758387 ] Use of undefined constants in DocBlockTags.inc on line 830
  155.  [ 764412 ] Complex class inheritance/package causes endless loop
  156.  [ 765753 ] Extraneous trailing "-" in @uses when no description
  157.  [ 765765 ] docbuilder can't change ini dir
  158.  
  159. The following bugs are fixed in version 1.2.0
  160.  [ 729841 ] Source code only for certain file if same name used
  161.  [ 730081 ] --ignore-tags docs unclear
  162.  [ 730214 ] weird filesource
  163.  [ 731560 ] docbuilder include error on linux
  164.  [ 731750 ] Links to unparsed includes shown
  165.  [ 732900 ] ordered list messes up
  166.  [ 733100 ] phpdoc's help output shows 2 times option "quiet"
  167.  [ 733352 ] optional description parameter in @license tag
  168.  [ 732642 ] DocBook support broken/incomplete.
  169.  [ 735697 ] the web interface
  170.  [ 736832 ] Fatal error in phpDocumentorTParser.inc
  171.  [ 739740 ] Page-level docs are not generated without a @package tag
  172.  [ 740859 ] @uses in docblock template crashes parser
  173.  [ 740871 ] crash in DocBlockTags.inc line 99
  174.  [ 741887 ] case-sensitivity bug
  175.  [ 744026 ] @uses breaks on Classes.inc
  176.  [ 744028 ] {@link $el, $notfound} returns blank text
  177.  [ 746674 ] phpedit - vars, methods
  178.  [ 746690 ] DocBlocks not parsed for require_once statements
  179.  [ 746692 ] makedoc.sh $TITLE bug
  180.  [ 747733 ] cannot use same filename + different path in @example
  181.  [ 748314 ] --pear on php4/pear uses . as dirname
  182.  [ 748837 ] @uses with spaces
  183.  [ 748850 ] {@link} documentation is unclear
  184.  
  185. The following bugs are fixed in version 1.2.0RC2
  186.  [ 708928 ] write permissions needed on some program dirs
  187.  [ 723230 ] warning on line 1391, HighlightParser
  188.  [ 723320 ] @param output behaves funny
  189.  [ 723767 ] space needed after @param type $var
  190.  [ 723947 ] RIC parsing not reading the correct README
  191.  [ 724415 ] Non-package references not always resolved
  192.  [ 724417 ] Multi-level method references not linked
  193.  [ 724701 ] conflicting package names, inherited links fails to show up
  194.  [ 724857 ] @link URL text broken
  195.  [ 725247 ] Wrong list handling in peardoc converter
  196.  [ 725745 ] HTML:Smarty:* not creating ric_README.html
  197.  [ 725161 ] File view displays class symbols without names
  198.  [ 725788 ] if --packageoutput excludes files with classes
  199.  [ 725742 ] code tag alignment
  200.  [ 726195 ] Formatting tags breaks lists
  201.  [ 726313 ] Changelog not linked
  202.  [ 727823 ] "#@+"-block quirck?
  203.  [ 728585 ] static keyword
  204.  [ 728167 ] HTML tags are case sensitive
  205.  
  206. The following bugs are fixed in version 1.2.0RC1
  207.  [ 566663 ] @param &$arg broken
  208.  [ 657041 ] {@source} doesn't work right
  209.  [ 675871 ] --pear breaks if not a pear repository
  210.  [ 678176 ] Inherited vars/methods in HTML:frames:phpedit
  211.  [ 680652 ] Optional method/function parameters
  212.  [ 681459 ] {@internal}} not quite working
  213.  [ 681463 ] {@source} drops characters
  214.  [ 681735 ] {@source} in sdesc needs warning
  215.  [ 682490 ] {@internal}} not parsed right by highlightparser
  216.  [ 682491 ] multi-line description fubared in @tag
  217.  [ 687091 ] special characters not encoded
  218.  [ 687364 ] highlightparser $class->member incorrect
  219.  [ 687403 ] {@source} leaves "}"
  220.  [ 689874 ] is_a is not avaliable in PHP 4.1.0
  221.  [ 689893 ] Warnings on PHP 4.1.0
  222.  [ 689894 ] getincludevalue() missing argument 2 warning
  223.  [ 692522 ] @uses is screwy
  224.  [ 693213 ] tutorials post-processed twice
  225.  [ 693215 ] {@internal}} on single line not working
  226.  [ 694448 ] PKZip has bug, use winzip (not phpDocumentor bug)
  227.  [ 694594 ] PEAR mode: destructor image not shown by phpedit template
  228.  [ 694742 ] PDF converter has no table of contents
  229.  [ 695291 ] link to todo disappears in HTML:Smarty:*
  230.  [ 695482 ] @uses not checking for @access private
  231.  [ 695622 ] HTML:Smarty:* has no package-level docs
  232.  [ 696883 ] <code> in description crashes parser
  233.  [ 697156 ] PHP Warning with PDF Converter
  234.  [ 697656 ] putting a <code> inside a <li> turns it into a literal
  235.  [ 698417 ] {@link element descrip} wrong
  236.  [ 697644 ] parse fails if unmatched html tag, or text outside <li> list
  237.  [ 698468 ] Fatal error when inline tag across two lines
  238.  [ 698356 ] {@internal} not working properly
  239.  [ 701199 ] extra br in @filesource generation
  240.  [ 702549 ] --quiet option not valid?
  241.  [ 705897 ] HTML:frames:earthli misses Page.gif
  242.  [ 708560 ] intelligent list handling isn't quite working
  243.  [ 708559 ] @category tag not really working
  244.  [ 710366 ] <i>-Tag is ignored
  245.  [ 710700 ] empty defaultpackagename = caused busy loop
  246.  [ 711569 ] Fatal Error: Undefined Method during write
  247.  [ 712704 ] HTML:Smarty:* drops class level author information
  248.  [ 708914 ] <var>, <samp>, <kbd> broken
  249.  [ 713201 ] variable variables are not parsed properly in @global
  250.  [ 713954 ] @param type $var when &$var broken
  251.  [ 715077 ] HighlightParser needs @tag object classname support
  252.  [ 715084 ] HighlightParser craps out after $var->
  253.  [ 715452 ] @example doesn't work with anything other than .php
  254.  [ 718253 ] Using 'parent' in @example file causes crash
  255.  
  256. The following bugs are fixed in version 1.2.0BETA3
  257.  [ 661317 ] PDF converter in subpackage ids broken
  258.  [ 669945 ] CHM: "undefined function: convert()" with multiple outputs 
  259.  [ 670205 ] inherited methods have no links
  260.  [ 670341 ] <pre> in docblock doesn't htmlentitie
  261.  [ 670350 ] left_frame.tpl missing package level doc link
  262.  [ 670440 ] Io::getBase() is buggy
  263.  [ 670903 ] inline desc <code> not <pre>-ized
  264.  [ 671620 ] warning in Parser line 2271
  265.  [ 672149 ] @desc broken
  266.  [ 674053 ] Support for require_once 
  267.  [ 674059 ] requires PHP version 4.2 or higher
  268.  [ 674075 ] Bad @param kills parser
  269.  [ 677105 ] unbalanced HTML-comments in output of HTML:frames:phpedit
  270.  [ 677821 ] define not parsed right in highlightparser
  271.  [ 677822 ] {@source} not showing whole source
  272.  [ 677826 ] nonsense @link in @see breaks HTML output
  273.  [ 677938 ] whitespace wrong after certain docblocks
  274.  
  275. The following bugs are fixed in version 1.2.0BETA2
  276.  [ 665707 ] Warnings and errors in new_phpdoc.php
  277.  [ 666307 ] whitespace not ignored in @param
  278.  [ 669132 ] "no @package tag was used" error but @ignore & @package used
  279.  [ 669525 ] {$children[kids].sdesc} contains parent sdesc
  280.  [ 669613 ] Call to undefined function: getclassleft()
  281.  [ 669615 ] methods disapper
  282.  [ 669640 ] javadocdesc broken
  283.  [ 669909 ] PDF text starts off left side of page when have package.html
  284.  
  285. The following bugs are fixed in version 1.2.0BETA1a
  286.  [ 661976 ] @see broken
  287.  [ 662630 ] {} delimited variables within strings mess up the parser
  288.  [ 663435 ] define values, global variable values need htmlentities
  289.  [ 664058 ] @param not displayed in HTMLframesConverter 
  290.  
  291. The following bugs are fixed in version 1.2.0BETA1
  292.  
  293.  [ 586357 ] ignore a directory
  294.  [ 637921 ] sorting is weird with multiple package
  295.  [ 637928 ] multiple converters legal, but fails
  296.  [ 638042 ] two declarations of checkstate()
  297.  [ 638128 ] commandline win32 fails, w/relative path
  298.  [ 639553 ] new_phpdoc.php fails with php 4.2.3
  299.  [ 640507 ] constructor links broken
  300.  [ 641076 ] second instance of loop fails
  301.  [ 641235 ] need trim of -f and -d commandline
  302.  [ 641334 ] parse <script language="php"> as <?php
  303.  [ 642427 ] Incorrect Anchor link from elementIndex
  304.  [ 645588 ] elements named "function.." or "global.." don't link
  305.  [ 646281 ] {@link mailto:e@a descrip} broken
  306.  [ 647494 ] {@link element1, element2} incorrect
  307.  [ 648684 ] links to global vars, defines in Smarty wrong
  308.  [ 649646 ] comments not parsed in function
  309.  [ 649953 ] phpdoc command-line only runs from install dir
  310.  [ 650946 ] link to phpdoc.org new window
  311.  [ 651837 ] getLink broken in rare case
  312.  [ 653627 ] @staticvar broken
  313.  [ 654429 ] tutorial prev/next links not working
  314.  [ 655372 ] smarty template not found in pdf convers
  315.  [ 657041 ] {@source} doesn't work right
  316.  [ 657387 ] parent/child tutorials converted twice
  317.  [ 657726 ] used by link htmlentitiezed
  318.  [ 657739 ] need separate categories of {@tags}
  319.  [ 657934 ] subtrees not processed in Converter
  320.  [ 658120 ] PDF define template has bug
  321.  [ 658121 ] PDF Converter not passing elements sorte
  322.  [ 661316 ] @tutorial tutorial.ext#subsection.section broken
  323.  
  324. There of course were other small bugs fixed, these were just the bugs with 
  325. entries in source forge.  You can view the bug details or reopen it if
  326. you think it's not totally fixed at:
  327. http://sourceforge.net/tracker/?group_id=11194&atid=111194
  328.  
  329. Features added that had Feature Request entries in SF for 1.2.2:
  330.  [ 776322 ] Parser cuts out on blank tags
  331.  
  332. Features added that had Feature Request entries in SF for 1.2.0:
  333.  [ 748419 ] Provide different tag variable types for template use
  334.  
  335. Features added that had Feature Request entries in SF for 1.2.0 rc 2:
  336.  [ 704808 ] command-line switch for template directory/converter directory
  337.  [ 722987 ] Relative example files
  338.  
  339. Features added that had Feature Request entries in SF for 1.2.0 rc 1:
  340.  [ 681470 ] Add syntax highlighting for <programlisting role="php"> 
  341.  [ 682810 ] Xref
  342.  [ 683101 ] starting/ending line numbers of docblocks/classes/methods
  343.  [ 687366 ] phpEdit-style list support
  344.  [ 695621 ] link to section of @filesource from each element
  345.  [ 714025 ] @license tag
  346.  
  347. Features added that had Feature Request entries in SF for 1.2.0 beta 3:
  348.  [ 674470 ] output a list of all @todos
  349.  [ 675194 ] -cp for converter-specific dynamic params 
  350.  
  351. Features added that had Feature Request entries in SF for 1.2.0 beta 2:
  352.  [ 650251 ] @filesource tag 
  353.  [ 670184 ] @example tag 
  354.  [ 670189 ] @internal/{@internal}} 
  355.  [ 670190 ] --ignore-tags command-line 
  356.  
  357. Features added that had Feature Request entries in SF for 1.2.0 beta 1a:
  358.  [ 663436 ] --title available in all pages, html
  359.  [ 663437 ] error if @package is missing 
  360.  [ 663439 ] PEAR command-line switch 
  361.  
  362. Features added that had Feature Request entries in SF for 1.2.0 beta 1:
  363.  
  364.  [ 541896 ] Create an Extended Howto
  365.  [ 558118 ] add {@inheritDoc}
  366.  [ 562604 ] Using @access blocs (_start ... _end)
  367.  [ 564991 ] auto-links to php manual
  368.  [ 566942 ] add {@link seeelement descrip}
  369.  [ 569746 ] make Program_root/ template thing
  370.  [ 577714 ] have master directory option
  371.  [ 586401 ] @access protected
  372.  [ 608603 ] REQUEST:class/function usage information
  373.  [ 615419 ] manuals like "php.net manual"
  374.  [ 623055 ] Zend IDE suport
  375.  [ 634518 ] inherit @author, @version, @copyright
  376.  [ 634589 ] @uses element
  377.  [ 634641 ] A way to document form variables
  378.  [ 635184 ] update all templates to phphtmllib
  379.  [ 637409 ] {keyword} - {data} pairs not flexible
  380.  [ 637660 ] parse type|type
  381.  [ 637920 ] simple way to extend a converter
  382.  [ 642235 ] Index of phphtmllib template
  383.  [ 645775 ] line numbers for elements
  384.  [ 651275 ] tutorials
  385.  [ 651716 ] automatically find README/INSTALL
  386.  [ 651723 ] @tutorial/{@tutorial}
  387.  [ 653608 ] allow the /user ini dir to be configable 
  388.  
  389. ################################################################################
  390.  
  391. The documentation has been updated for this release you can view it at
  392. http://phpdocu.sourceforge.net/spec/
  393. or in the distribution in the spec directory
  394.  
  395. The changelog is available in the tarball, or online at 
  396. http://phpdocu.sourceforge.net/Changelog
  397.  
  398. You can download the newest version from 
  399. http://phpdocu.sourceforge.net/downloads.php
  400.  
  401. And of course you can reach the webpage at http://phpdocu.sourceforge.net/ or 
  402. http://phpdoc.org/ 
  403.  
  404. enjoy
  405. -joshua eichorn <jeichorn@phpdoc.org>
  406. -gregory beaver <cellog@users.sourceforge.net>
  407.  
  408.  
  409. vim: set expandtab :
  410.